Interface NFExporter

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
NFExporterImpl

public interface NFExporter extends Process
Information provided by the PKI file:

    \class NFExporter
    
    \brief NFExporter handles and manipulates NetFlow exporters.
    
    \example network().getDevice("Router0").getNetflowExporterManager().getNFExporterAt(0)
    
Author:
Auto-generated
  • Method Details

    • getTemplateById

      NFTemplate getTemplateById(int id)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow template with the specified ID.
          
          \param id, the ID of the NetFlow template of interest.
          
          \return NFTemplate, the NFTemplate object with the specified ID.
          
              
      Parameters:
      id - Takes in a parameter of id
      Returns:
      NFTemplate Returns a NFTemplate
    • getTemplateByRecordName

      NFTemplate getTemplateByRecordName(String recordName)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow template with the specified record name.
          
          \param recordName, the record name of the NetFlow template of interest.
          
          \return NFTemplate, the NFTemplate object with the specified record name.
          
              
      Parameters:
      recordName - Takes in a parameter of recordName
      Returns:
      NFTemplate Returns a NFTemplate
    • removeTemplate

      boolean removeTemplate(int templateId)
      Information provided by the PKI file:
      
          \brief Removes the NetFlow template with the specified ID.
          
          \param templateId, the ID of the NetFlow template of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      templateId - Takes in a parameter of templateId
      Returns:
      boolean Returns a boolean
    • setExporterName

      void setExporterName(String name)
      Information provided by the PKI file:
      
          \brief Sets the name for the NetFlow exporter.
          
          \param name, the name for the NetFlow exporter.
          
              
      Parameters:
      name - Takes in a parameter of name
    • getExporterName

      String getExporterName()
      Information provided by the PKI file:
      
          \brief Returns the name of the NetFlow exporter.
          
          \return string, the name of the NetFlow exporter.
          
              
      Returns:
      String Returns a String
    • setExporterVersion

      void setExporterVersion(int version)
      Information provided by the PKI file:
      
          \brief Sets the version for the NetFlow exporter.
          
          \param version, the version for the NetFlow exporter.
          
              
      Parameters:
      version - Takes in a parameter of version
    • getExporterVersion

      int getExporterVersion()
      Information provided by the PKI file:
      
          \brief Returns the version of the NetFlow exporter.
          
          \return int, the version of the NetFlow exporter.
          
              
      Returns:
      int Returns a int
    • getDeviceUpTime

      long getDeviceUpTime()
      Information provided by the PKI file:
      
          \brief Returns the device up time.
          
          \return int, the device up time.
          
              
      Returns:
      long Returns a long
    • isFullyConfigured

      boolean isFullyConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the NetFlow exporter is fully configured, otherwise false.
          
          \return bool, true if the NetFlow exporter is fully configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setSrcPort

      void setSrcPort(String port)
      Information provided by the PKI file:
      
          \brief Sets the source port.
          
          \param port,        portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Parameters:
      port - Takes in a parameter of port
    • getSrcPort

      Port getSrcPort()
      Information provided by the PKI file:
      
          \brief Returns the source port.
          
          \return Port, the Port object of the source port.
          
              
      Returns:
      Port Returns a Port
    • setDestinationAddr

      void setDestinationAddr(IPAddress ip_add)
      Information provided by the PKI file:
      
          \brief Sets the destination IP address.
          
          \param ip_add, the IP address of the destination.
          
              
      Parameters:
      ip_add - Takes in a parameter of ip_add
    • getDestinationAddr

      IPAddress getDestinationAddr()
      Information provided by the PKI file:
      
          \brief Returns the destination IP address.
          
          \return ip, the IP address of the destination.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • setDestinationUdpPort

      void setDestinationUdpPort(int port)
      Information provided by the PKI file:
      
          \brief Sets the destination UDP port number.
          
          \param port, the UDP port number for the destination.
          
              
      Parameters:
      port - Takes in a parameter of port
    • getDestinationUdpPort

      int getDestinationUdpPort()
      Information provided by the PKI file:
      
          \brief Returns the destination UDP port number.
          
          \return int, the UDP port number of the destination.
          
              
      Returns:
      int Returns a int
    • addMonitor

      void addMonitor(String monitorName)
      Information provided by the PKI file:
      
          \brief Adds a monitor with the specified name.
          
          \param monitorName, the name for the monitor.
          
              
      Parameters:
      monitorName - Takes in a parameter of monitorName
    • removeMontior

      void removeMontior(String monitorName)
      Information provided by the PKI file:
      
          \brief Removes the monitor with the specified name.
          
          \param monitorName, the name of the monitor of interest.
          
              
      Parameters:
      monitorName - Takes in a parameter of monitorName
    • createFrameInstance

      FrameInstance createFrameInstance()
      Information provided by the PKI file:
      
          \brief Creates a frame instance.
          
          \return FrameInstance, the FrameInstance object of the frame instance.
          
              
      Returns:
      FrameInstance Returns a FrameInstance